home *** CD-ROM | disk | FTP | other *** search
/ Personal Computer World 2009 February / PCWFEB09.iso / Software / Linux / SLAX 6.0.8 / slax-6.0.8.iso / slax / base / 006-devel.lzm / usr / include / kleo / refreshkeysjob.h < prev    next >
Encoding:
C/C++ Source or Header  |  2005-09-10  |  3.1 KB  |  91 lines
  1. /*
  2.     refreshkeysjob.h
  3.  
  4.     This file is part of libkleopatra, the KDE keymanagement library
  5.     Copyright (c) 2004 KlarΣlvdalens Datakonsult AB
  6.  
  7.     Libkleopatra is free software; you can redistribute it and/or
  8.     modify it under the terms of the GNU General Public License as
  9.     published by the Free Software Foundation; either version 2 of the
  10.     License, or (at your option) any later version.
  11.  
  12.     Libkleopatra is distributed in the hope that it will be useful,
  13.     but WITHOUT ANY WARRANTY; without even the implied warranty of
  14.     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15.     General Public License for more details.
  16.  
  17.     You should have received a copy of the GNU General Public License
  18.     along with this program; if not, write to the Free Software
  19.     Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
  20.  
  21.     In addition, as a special exception, the copyright holders give
  22.     permission to link the code of this program with any edition of
  23.     the Qt library by Trolltech AS, Norway (or with modified versions
  24.     of Qt that use the same license as Qt), and distribute linked
  25.     combinations including the two.  You must obey the GNU General
  26.     Public License in all respects for all of the code used other than
  27.     Qt.  If you modify this file, you may extend this exception to
  28.     your version of the file, but you are not obligated to do so.  If
  29.     you do not wish to do so, delete this exception statement from
  30.     your version.
  31. */
  32.  
  33. #ifndef __KLEO_REFRESHKEYSJOB_H__
  34. #define __KLEO_REFRESHKEYSJOB_H__
  35.  
  36. #include "job.h"
  37.  
  38. #include <vector>
  39.  
  40. namespace GpgME {
  41.   class Error;
  42.   class Key;
  43. }
  44.  
  45. class QStringList;
  46.  
  47. namespace Kleo {
  48.  
  49.   /**
  50.      @short An abstract base class for asynchronous key refreshers.
  51.  
  52.      To use a RefreshKeysJob, first obtain an instance from the
  53.      CryptoBackend implementation, connect the progress() and result()
  54.      signals to suitable slots and then start the key refresh with a
  55.      call to start(). This call might fail, in which case the
  56.      RefreshKeysJob instance will have scheduled its own destruction
  57.      with a call to QObject::deleteLater().
  58.  
  59.      After result() is emitted, the KeyListJob will schedule it's own
  60.      destruction by calling QObject::deleteLater().
  61.   */
  62.   class RefreshKeysJob : public Job {
  63.     Q_OBJECT
  64.   protected:
  65.     RefreshKeysJob( QObject * parent, const char * name );
  66.  
  67.   public:
  68.    ~RefreshKeysJob();
  69.  
  70.      /**
  71.        Starts the keylist operation. \a pattern is a list of patterns
  72.        used to restrict the list of keys returned. Empty patterns are
  73.        ignored. If \a pattern is empty or contains only empty strings,
  74.        all keys are returned (however, the backend is free to truncate
  75.        the result and should do so; when this happens, it will be
  76.        reported by the reult object).
  77.  
  78.        If \a secretOnly is true, only keys for which the secret key is
  79.        also available are returned. Use this if you need to select a
  80.        key for signing.
  81.     */
  82.     virtual GpgME::Error start( const QStringList & patterns ) = 0;
  83.  
  84.   signals:
  85.     void result( const GpgME::Error & error );
  86.   };
  87.  
  88. }
  89.  
  90. #endif // __KLEO_REFRESHKEYSJOB_H__
  91.